<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-DocXMLRPCServer.html" />
<link rel="prev" href="module-xmlrpclib.html" />
<link rel="parent" href="internet.html" />
<link rel="next" href="simple-xmlrpc-servers.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>18.25 SimpleXMLRPCServer -- Basic XML-RPC server</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.24.9 example of Client"
  href="xmlrpc-client-example.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18. internet Protocols and"
  href="internet.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.25.1 simplexmlrpcserver Objects"
  href="simple-xmlrpc-servers.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="xmlrpc-client-example.html">18.24.9 Example of Client</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="internet.html">18. Internet Protocols and</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="simple-xmlrpc-servers.html">18.25.1 SimpleXMLRPCServer Objects</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION00202500000000000000000">
18.25 <tt class="module">SimpleXMLRPCServer</tt> --
         Basic XML-RPC server</a>
</h1>

<p>
<a name="module-SimpleXMLRPCServer"></a>

<p>

<span class="versionnote">New in version 2.2.</span>

<p>
The <tt class="module">SimpleXMLRPCServer</tt> module provides a basic server
framework for XML-RPC servers written in Python.  Servers can either
be free standing, using <tt class="class">SimpleXMLRPCServer</tt>, or embedded in a
CGI environment, using <tt class="class">CGIXMLRPCRequestHandler</tt>.

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-4465' xml:id='l2h-4465' class="class">SimpleXMLRPCServer</tt></b>(</nobr></td>
  <td><var>addr</var><big>[</big><var>,
                                      requestHandler</var><big>[</big><var>,
					logRequests</var><big>[</big><var>, allow_none</var><big>[</big><var>, encoding</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>

<p>
Create a new server instance.  This class
  provides methods for registration of functions that can be called by
  the XML-RPC protocol.  The <var>requestHandler</var> parameter
  should be a factory for request handler instances; it defaults to
  <tt class="class">SimpleXMLRPCRequestHandler</tt>.  The <var>addr</var> and
  <var>requestHandler</var> parameters are passed to the
  <tt class="class"><tt class="module"><a href="module-SocketServer.html">SocketServer</a></tt>.TCPServer</tt> constructor.  If
  <var>logRequests</var> is true (the default), requests will be logged;
  setting this parameter to false will turn off logging.  
  The <var>allow_none</var> and <var>encoding</var> parameters are passed on to 
  <tt class="module">xmlrpclib</tt> and control the XML-RPC responses that will be returned 
  from the server.
  
<span class="versionnote">Changed in version 2.5:
The <var>allow_none</var> and <var>encoding</var> parameters were added.</span>

</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-4466' xml:id='l2h-4466' class="class">CGIXMLRPCRequestHandler</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>allow_none</var><big>[</big><var>, encoding</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
  Create a new instance to handle XML-RPC requests in a CGI
  environment. 
  The <var>allow_none</var> and <var>encoding</var> parameters are passed on to 
  <tt class="module">xmlrpclib</tt> and control the XML-RPC responses that will be returned 
  from the server.
  
<span class="versionnote">New in version 2.3.</span>

<span class="versionnote">Changed in version 2.5:
The <var>allow_none</var> and <var>encoding</var> parameters were added.</span>

</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-4467' xml:id='l2h-4467' class="class">SimpleXMLRPCRequestHandler</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Create a new request handler instance.  This request handler
  supports <code>POST</code> requests and modifies logging so that the
  <var>logRequests</var> parameter to the <tt class="class">SimpleXMLRPCServer</tt>
  constructor parameter is honored.
</dl>

<p>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<a name="CHILD_LINKS"><strong>Subsections</strong></a>

<ul class="ChildLinks">
<li><a href="simple-xmlrpc-servers.html">18.25.1 SimpleXMLRPCServer Objects</a>
<li><a href="node661.html">18.25.2 CGIXMLRPCRequestHandler</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.24.9 example of Client"
  href="xmlrpc-client-example.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18. internet Protocols and"
  href="internet.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.25.1 simplexmlrpcserver Objects"
  href="simple-xmlrpc-servers.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="xmlrpc-client-example.html">18.24.9 Example of Client</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="internet.html">18. Internet Protocols and</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="simple-xmlrpc-servers.html">18.25.1 SimpleXMLRPCServer Objects</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
